README OS X

   1 ------------------------------------------------------------------------
   2 Introduction
   3 ------------------------------------------------------------------------
   4
   5 This is the Mac OS X version of James McCartney's SuperCollider
   6 synthesis engine (scsynth) and programming language (sclang).
   7 Supercollider's main homepage is at:
   8
   9    http://supercollider.sourceforge.net/
  10
  11 To get further information on SuperCollider usage or development, you
  12 should subscribe to the mailing lists:
  13
  14    http://swiki.hfbk-hamburg.de:8888/MusicTechnology/880
  15
  16 Do not use non-ASCII characters (above code point 127) in your SuperCollider program path. Doing so will break options to open class or method files automatically.
  17
  18 ------------------------------------------------------------------------
  19 System Requirements
  20 ------------------------------------------------------------------------
  21
  22 Mac OS X 10.4.9 or greater
  23 Xcode Tools 2.4.1 or greater
  24
  25 ------------------------------------------------------------------------
  26 Building
  27 ------------------------------------------------------------------------
  28
  29 The easy way:
  30         ./clean-compile.sh
  31         ./package.sh
  32
  33 Your build will be placed in a directory named "SuperCollider".
  34
  35 If you run into problems building the most likely cause is that you are
  36 not running the correct version of the Xcode tools. You must be running
  37 2.4.1 or above!
  38
  39 Building within Xcode:
  40         There are three projects that should be BUILT IN THIS ORDER:
  41
  42         Synth
  43          - the synthesis server application
  44
  45         Plugins
  46          - the UGens and plugins
  47
  48         Language
  49          - the OS X application with text editor, language interpreter,
  50            event scheduling etc.
  51
  52 The package.sh script does several maintenance tasks (fixing creator
  53 codes, exporting from svn, etc) and creates a ready-to-distribute zip of
  54 SuperCollider.
  55
  56 ------------------------------------------------------------------------
  57 On libsndfile
  58 ------------------------------------------------------------------------
  59
  60 Compiling a universal binary of libsndfile requires access to both a
  61 i386 and PPC Mac. The reasons for this are described here:
  62
  63 http://www.mega-nerd.com/libsndfile/FAQ.html#Q018
  64
  65 Because of this, libsndfile is included with the source as a precompiled
  66 universal binary. This UB contains ppc, i386 and x86_64 archs.
  67
  68 ------------------------------------------------------------------------
  69 Building - 10.6 and 64-bit scsynth and plugins
  70 ------------------------------------------------------------------------
  71
  72 You will need to do the following to build a 64-bit scsynth and plugins.
  73 Open the XCode projects for Synth and Plugins
  74 Double-click each target, and change the
  75         Architectures setting to 'Standard (32-bit/64-bit Universal)
  76         Base-SDK to 10.5
  77         (optional and recommended): Compiler to GCC 4.2 (if available)
  78
  79 This definitely works in Mac OS 10.6, probably 10.5, and these builds will NOT support 10.4
  80
  81 XCode in 10.6 uses the GCC 4.2 compiler by default, and this compiler will NOT work with the 10.4 SDK (the default SDK). You will need to either set your build SDK to 10.5 or 10.6 inside each XCode project, or inspect (double-click) each target and set GCC 4.0 as your compiler.
  82
  83 UPDATE - There is now a Deployment32-64 build style that should build SuperCollider from source out of the box on 10.6. You can also use the compile.sh script and pass in ARCHS=32_64 as a flag:
  84     ./compile.sh ARCHS=32_64
  85 This should build a 32/64 bit version of scsynth and the plugins and a 32-bit SuperCollider.app. This build style should use the 10.5 SDK by default.
  86
  87 The 10.6 SDK still has some problems. If you are on 10.6, please make sure you have installed the 10.5 SDK installed with the developer tools.
  88
  89 ------------------------------------------------------------------------
  90 Outro
  91 ------------------------------------------------------------------------
  92
  93 Thanks to James McCartney, for making this great piece of audio
  94 software publicly and freely available.
  95
  96 ------------------------------------------------------------------------